Extension point schema
In component org.nuxeo.ecm.core.schema.TypeService
Documentation
Extension Point to register new schemas.
Schemas are defined using XSD files. The schema extension XML may containg several 'schema' objects as the following ones:
<schema name="common" src="schema/common.xsd"/>
<schema name="dublincore" prefix="dc" src="schema/dublincore.xsd"/>
The name attribute uniquely identify the schema, the src attribute specify the path to that schema (relative to the bundle root) and the prefix is used as a prefix (short name) of the schema namespace. The schema namespace is the targetNamespace defined inside the XSD file
Note that multiple schemas can share the same target namespace and prefix
You can also create a Nuxeo Schema from a sub part of the XSD schema. For that you can use the xsdRootElement attribute to indicate the complex type to use.
<schema name="employeeSchema" src="schema/testExtension.xsd" xsdRootElement="employee"/>
A schema can be completely disabled with:
<schema enabled="false" name="myOldSchema"/>
Schemas with enabled=false will be ignored in all document types and facets still referencing them, and will not be returned when listing available schemas.
Extension Point is also used to register additional property information, called property characteristic, such as:
- secured: only administrators can edit it
- deprecation: flag property as deprecated or removed
XML extensions may contain any number of 'property' elements of the form:
<property name="creator" schema="dublincore" secured="true"/>
<property deprecation="deprecated" name="size" schema="common"/>
<property deprecation="removed" fallback="content/name"
name="filename" schema="file"/>
Properties declared with secured attribute can only be edited by administrators.
Properties declared with deprecation attribute enable deprecation mechanism inside Nuxeo Platform. This generates WARN message of usage to help to remove deprecated usage.
A contribution is one of these types:
- deprecated: property still exists in schema definition, but it'll be removed in next version
- removed: property has been removed from schema definition, relax platform behavior. This will avoid Nuxeo property not found exceptions for remaining use of the property
The fallback attribute is optional, its value has to be a xpath referencing an existing property in the same schema than deprecated/removed property. When presents, it is used:
- to set the value to the fallback property
- to get the value from the fallback property if it exists
Note: for a deprecated property, setValue also set value to property and getValue get value from property if fallback value is null.
For example, the contribution below enables WARN message of usage of property file:filename . This will also get/set the value from/to file:content/name for deprecated usage of file:filename property.
<property deprecation="deprecated" fallback="content/name"
name="filename" schema="file"/>
As it, each usage of this property will automatically fallback on the fallback and avoid exception from platform. This will also allows to import document declaring the removed property.
Contribution Descriptors
- Class: org.nuxeo.ecm.core.schema.SchemaBindingDescriptor
- Class: org.nuxeo.ecm.core.schema.PropertyDescriptor
Existing Contributions
Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.
-
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <documentation>The core schemas</documentation> <!-- XXX AT: prefixes should be set, see NXP-1152 --> <schema name="core-types" src="schema/core-types.xsd"/> <schema name="base" src="schema/base.xsd"/> <schema name="relation" prefix="relation" src="schema/relation.xsd"/> <schema name="common" src="schema/common.xsd"/> <schema name="dublincore" prefix="dc" src="schema/dublincore.xsd"/> <schema name="uid" src="schema/uid.xsd"/> <schema name="file" src="schema/file.xsd"/> <schema name="files" src="schema/files.xsd"/> <schema name="note" src="schema/note.xsd"/> <schema name="domain" src="schema/domain.xsd"/> <schema name="relatedtext" src="schema/relatedtext.xsd"/> <schema name="publishing" prefix="publish" src="schema/publishing.xsd"/> <schema name="webcontainer" prefix="webc" src="schema/webcontainer.xsd"/> <schema name="collection" prefix="collection" src="schema/collection.xsd"/> <schema isVersionWritable="true" name="collectionMember" prefix="collectionMember" src="schema/collectionMember.xsd"/> <property indexOrder="ascending" name="documentIds" schema="collection"/> <property indexOrder="ascending" name="collectionIds" schema="collectionMember"/> <property name="created" schema="dublincore" secured="true"/> <property indexOrder="descending" name="modified" schema="dublincore" secured="true"/> <property name="creator" schema="dublincore" secured="true"/> <property name="contributors" schema="dublincore" secured="true"/> <property name="lastContributor" schema="dublincore" secured="true"/> <!-- Removed since 9.1 --> <property deprecation="removed" name="size" schema="common"/> <property deprecation="removed" fallback="content/name" name="filename" schema="file"/> <property deprecation="removed" fallback="files/*/file/name" name="files/*/filename" schema="files"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="nxbundle" prefix="nxbundle" src="schemas/nxbundle.xsd"/> <schema name="nxbundlegroup" prefix="nxbundlegroup" src="schemas/nxbundlegroup.xsd"/> <schema name="nxcomponent" prefix="nxcomponent" src="schemas/nxcomponent.xsd"/> <schema name="nxcontribution" prefix="nxcontribution" src="schemas/nxcontribution.xsd"/> <schema name="nxdistribution" prefix="nxdistribution" src="schemas/nxdistribution.xsd"/> <schema name="nxextensionpoint" prefix="nxextensionpoint" src="schemas/nxextensionpoint.xsd"/> <schema name="nxservice" prefix="nxservice" src="schemas/nxservice.xsd"/> <schema name="nxoperation" prefix="nxop" src="schemas/nxoperation.xsd"/> <schema name="nxpackage" prefix="nxpackage" src="schemas/nxpackage.xsd"/> <schema name="apidoccommon" prefix="adc" src="schemas/apidoccommon.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="common-aspera" prefix="ca" src="schemas/common-aspera.xsd"/> <schema name="aspera_search" src="schemas/aspera_search.xsd"/> <schema name="transfer-dc" prefix="tdc" src="schemas/transfer-dc.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="coldstorage" prefix="coldstorage" src="schemas/coldstorage.xsd"/> <property indexOrder="ascending" name="content/digest" schema="file"/> <property indexOrder="ascending" name="beingRetrieved" schema="coldstorage"/> <property indexOrder="ascending" name="coldContent/digest" schema="coldstorage"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="status" src="schemas/status.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="permissions_search" prefix="rs" src="schemas/permissions_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="assets_search" src="schemas/assets_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="driveroot" prefix="drv" src="schema/driveroot.xsd"/> <property indexOrder="ascending" name="subscriptions/*/enabled" schema="driveroot"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="registration" prefix="registration" src="schemas/registration.xsd"/> <schema name="userinfo" prefix="userinfo" src="schemas/userinfo.xsd"/> <schema name="registrationconfiguration" prefix="registrationconfiguration" src="schemas/registrationconfiguration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="blobconversions" prefix="blobconversions" src="schemas/blobconversions.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="simpleconfiguration" prefix="sconf" src="schemas/simpleconfiguration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="tenantconfig" prefix="tenantconfig" src="schemas/tenantconfig.xsd"/> <!-- multi tenant vocabulary --> <schema name="multitenantvocabulary" src="schemas/multi_tenant_vocabulary.xsd"/> <schema name="multitenantxvocabulary" src="schemas/multi_tenant_xvocabulary.xsd"/> <schema name="multitenantl10nvocabulary" src="schemas/multi_tenant_l10nvocabulary.xsd"/> <schema name="multitenantl10nxvocabulary" src="schemas/multi_tenant_l10nxvocabulary.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="aceinfo" prefix="aceinfo" src="schemas/aceinfo.xsd"/> <property indexOrder="ascending" name="id" schema="aceinfo"/> <property indexOrder="ascending" name="docId" schema="aceinfo"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="threed" prefix="threed" src="schemas/threed.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="basicauditsearch" prefix="bas" src="schemas/basicauditsearch.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="comment" prefix="comment" src="schema/comment.xsd"/> <schema name="annotation" prefix="annotation" src="schema/annotation.xsd"/> <schema name="externalEntity" prefix="externalEntity" src="schema/externalEntity.xsd"/> <property indexOrder="ascending" name="xpath" schema="annotation"/> <!-- TODO remove it when PropertyCommentManager will be removed --> <property indexOrder="ascending" name="parentId" schema="comment"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="tenant" src="schemas/tenant.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="directory_configuration" prefix="dirconf" src="schemas/directory_configuration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="user" src="directoryschema/user.xsd"/> <schema name="group" src="directoryschema/group.xsd"/> <schema name="vocabulary" src="directoryschema/vocabulary.xsd"/> <schema name="xvocabulary" src="directoryschema/xvocabulary.xsd"/> <schema name="l10nvocabulary" src="directoryschema/l10nvocabulary.xsd"/> <schema name="l10nxvocabulary" src="directoryschema/l10nxvocabulary.xsd"/> <schema name="documentsLists" src="directoryschema/documentsLists.xsd"/> <property indexOrder="ascending" name="username" schema="user"/> <property indexOrder="ascending" name="groupname" schema="group"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="picturebook" src="schema/picturebook.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="digestauth" src="schema/digestauth.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="shibbolethGroup" src="schema/shibb-group.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="authtoken" src="directoryschema/authtoken.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="mail" prefix="mail" src="schemas/mail.xsd"/> <schema name="protocol" prefix="prot" src="schemas/protocol.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema isVersionWritable="true" name="notification" prefix="notif" src="schemas/notification.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="oauth2ServiceProvider" src="schemas/oauth2serviceprovider.xsd"/> <schema name="oauth2Token" src="schemas/oauth2token.xsd"/> <schema name="oauth2Client" src="schemas/oauth2client.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <property indexOrder="ascending" name="accessToken" schema="oauth2Token"/> <property indexOrder="ascending" name="serviceName" schema="oauth2Token"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="oauthConsumer" src="schemas/oauthconsumer.xsd"/> <schema name="oauthServiceProvider" src="schemas/oauthserviceprovider.xsd"/> <schema name="oauthToken" src="schemas/oauthtoken.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="relation_search" prefix="rel_srch" src="schemas/relation_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="rendition" prefix="rend" src="schemas/rendition.xsd"/> <property indexOrder="ascending" name="renditionName" schema="rendition"/> <property indexOrder="ascending" name="sourceId" schema="rendition"/> <property indexOrder="ascending" name="sourceVersionableId" schema="rendition"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="stored_rendition_search" prefix="stored_rend_srch" src="schemas/stored_rendition_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="cert" src="schemas/cert.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="tag" prefix="tag" src="schemas/tag.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="picture" src="schema/picture.xsd"/> <schema name="image_metadata" prefix="imd" src="schema/image_metadata.xsd"/> <schema name="iptc" prefix="iptc" src="schema/iptc.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="audio" prefix="aud" src="schema/audio.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="task" prefix="nt" src="schemas/task.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="content_view_configuration" prefix="cvconf" src="schemas/content_view_configuration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="ui_types_configuration" prefix="uitypesconf" src="schemas/ui_types_configuration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="docinfo" prefix="docinfo" src="schemas/docinfo.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="video" prefix="vid" src="schemas/video.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="advanced_search" prefix="search" src="schemas/advanced_search.xsd"/> <schema name="advanced_content" prefix="advanced_content" src="schemas/advanced_content.xsd"/> <schema name="content_view_display" prefix="cvd" src="schemas/content_view_display.xsd"/> <schema name="expired_search" prefix="expired_search" src="schemas/expired_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="documents_count_statistics" prefix="dcs" src="schemas/documents_count_statistics.xsd"/> <schema name="documents_size_statistics" prefix="dss" src="schemas/documents_size_statistics.xsd"/> <schema name="quota_heaviest_containers_cv" prefix="quota_heaviest_containers_cv" src="schemas/quota_heaviest_containers_cv.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="retention_rule" prefix="retention_rule" src="schemas/retention_rule.xsd"/> <schema name="retention_definition" prefix="retention_def" src="schemas/retention_definition.xsd"/> <schema name="record" prefix="record" src="schemas/record.xsd"/> <schema name="retention_search" prefix="retention_search" src="schemas/retention_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="document_route_instance" prefix="docri" src="schemas/document_route_instance.xsd"/> <schema name="document_route_model" prefix="docrm" src="schemas/document_route_model.xsd"/> <schema name="info_comments" prefix="infocom" src="schemas/info_comments.xsd"/> <schema name="route_node" prefix="rnode" src="schemas/route_node.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="var_global_Task2169" override="true" prefix="var_global_Task2169" src="data/schemas/var_global_Task2169.xsd"/> <schema name="var_Task2169" override="true" prefix="var_Task2169" src="data/schemas/var_Task2169.xsd"/> <schema name="var_Task21a0" override="true" prefix="var_Task21a0" src="data/schemas/var_Task21a0.xsd"/> <schema name="var_Task2225" override="true" prefix="var_Task2225" src="data/schemas/var_Task2225.xsd"/> <schema name="var_Task22b4" override="true" prefix="var_Task22b4" src="data/schemas/var_Task22b4.xsd"/> <schema name="var_Task232e" override="true" prefix="var_Task232e" src="data/schemas/var_Task232e.xsd"/> <schema name="var_global_Task2556" override="true" prefix="var_global_Task2556" src="data/schemas/var_global_Task2556.xsd"/> <schema name="var_Task2556" override="true" prefix="var_Task2556" src="data/schemas/var_Task2556.xsd"/> <schema name="var_global_Task328d" override="true" prefix="var_global_Task328d" src="data/schemas/var_global_Task328d.xsd"/> <schema name="var_Task328d" override="true" prefix="var_Task328d" src="data/schemas/var_Task328d.xsd"/> <schema name="var_ParallelDocumentReview" override="true" prefix="var_ParallelDocumentReview" src="data/schemas/var_ParallelDocumentReview.xsd"/> <schema name="var_Task375f" override="true" prefix="var_Task375f" src="data/schemas/var_Task375f.xsd"/> <schema name="var_global_Task38e" override="true" prefix="var_global_Task38e" src="data/schemas/var_global_Task38e.xsd"/> <schema name="var_Task38e" override="true" prefix="var_Task38e" src="data/schemas/var_Task38e.xsd"/> <schema name="var_Task542" override="true" prefix="var_Task542" src="data/schemas/var_Task542.xsd"/> <schema name="var_Task5c1" override="true" prefix="var_Task5c1" src="data/schemas/var_Task5c1.xsd"/> <schema name="var_global_Task6d8" override="true" prefix="var_global_Task6d8" src="data/schemas/var_global_Task6d8.xsd"/> <schema name="var_Task6d8" override="true" prefix="var_Task6d8" src="data/schemas/var_Task6d8.xsd"/> <schema name="var_SerialDocumentReview" override="true" prefix="var_SerialDocumentReview" src="data/schemas/var_SerialDocumentReview.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="user_open_tasks_cv" prefix="user_open_tasks_cv" src="schemas/user_open_tasks_cv.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="salesforce" prefix="sf" src="schema/salesforce.xsd"/> <schema name="salesforce_search" prefix="sfs" src="schema/salesforce_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="jwt_keystore" src="schema/jwt_keystore.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="saved_search" prefix="saved" src="schemas/saved_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="default_search" prefix="defaults" src="schemas/default_search.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="search_configuration" prefix="searchc" src="schemas/search_configuration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="documenttemplate" prefix="tmpl" src="schemas/documenttemplate.xsd"/> <schema name="templatesupport" prefix="nxts" src="schemas/templatesupport.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="theme_configuration" prefix="themeconf" src="schemas/theme_configuration.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="thumbnail" prefix="thumb" src="schemas/thumbnail.xsd"/> </extension> -
<extension point="schema" target="org.nuxeo.ecm.core.schema.TypeService"> <schema name="userprofile" prefix="userprofile" src="schemas/userprofile.xsd"/> </extension>